home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / smdiv25.zip / SMDI.DOC (.txt) < prev    next >
Microsoft Windows Help File Content  |  1993-04-06  |  13KB  |  238 lines
  1.                        Documentation For
  2.               THE SILVER MAGE DATA INFORMATION MANAGER 
  3.                          Version 2.5
  4.                      Released April 1993
  5.               Copyright (C) 1993 By Joseph W. Teller
  6. :FEATURES
  7.      Useable on a BBS as a Door or as part of a Logon Event to
  8. provide information,, entertainment and personally useful data in
  9. a timely and attractive fashion.
  10.      All features are optionals* and include:
  11.          ANSI_Pictures*     (Monthly & Daily)
  12.          Birthdays*         (Historic and otherwise)
  13.          Bulletins*         (Unlimited!)
  14.          Dated_Reminders    (Taxes Due! Books Overdue! Subscriptions!)
  15.          Delays_&_Ads*      (Sorry but necessary till you register!)
  16.          History*           (What happened in it TODAY?)
  17.          Quote*             (Daily Random Quotes & Secret Knowledge!)
  18.          Special_Reminders* (Day of Week, Month of Year etc)
  19.         
  20.   NOTE: If you have a copy of DART HYPERTEXT, you'll find that these
  21.         documentation pages are designed to be compatible with it
  22.         to make your life easier while getting things set up, but
  23.         if you don't you can still read it as a normal text file.
  24. :REQUIREMENTS
  25.      SMDI Requires you to be running DOS 3.3 or better, that all its
  26. files be placed in the same directory, and that your BBS produce a
  27. DORINFO1.DEF File, OR a WWIV-Style CHAIN.TXT.
  28.      BRUN45 is included in the distribution, but if you already have
  29. a copy that is patched for communications then you can discard the
  30. extra copy and save yourself some disk space. Just make sure the PATH
  31. to it has been set in your system SET statement.
  32. :CFG_FILE
  33.      The file SMDI.CFG is a sample configuration file for the program.
  34. Line By Line it should contain:
  35.         1 The Path and filename of your DORINFOx.DEF file, where x
  36.           is the node number you are running the program on (1 is
  37.           the default to use on most boards unless you are multiline)
  38.         2 The Name of Your BBS
  39.         3 The Sysops First Name
  40.         4 The Sysops Last (family) Name
  41.           
  42. Any additional lines can be blank or may have numbers in them, they are
  43. not actually used.
  44. If you are Running WWIV (or one of its Clones) you should be able to
  45. run this program as a Chain. Simply make sure that line 1 is the
  46. Path and Filename to your CHAIN.TXT file and you should be fine.
  47. :Fossil_Driver_Support
  48.        If your BBS uses a standard Fossil Driver like BNU, then you can
  49. tell the door to utilize it by the adding of a switch to the command
  50. line when you call the program:
  51.        SMDI.EXE SMDI.CFG /FD
  52. :OPTIONALS
  53.     All Data Files used with SMDI are OPTIONAL. This means you can as
  54. the sysop decide which features are actually used on your system. Some
  55. folks get bothered by too many displays, bulletins etc and you as sysop
  56. can decide what is important to you. Simply delete any files that you
  57. find unnecessary and the program will skip over that section of its
  58. operation.
  59.     Both ANSI and NON-ANSI Users are supported thru this program.
  60. :Running_The_Program
  61.     Is simple once you have the CFG file set, just run it from your bbs
  62. inside a batch file as:
  63.          SMDI.EXE SMDI.CFG
  64.      And exit back to your board as needed after its running.
  65. :Support
  66.     If you have problems or questions, I can be left mail on my own
  67. BBS at (617) 899-9483 where the SMDI is going to be used regularly.
  68. New versions will be released there first.
  69.     The program was written using standard Quickbasic 4.5 and a
  70. registered version of Ted Freeman's wonderfully useful DOORFRAME 3.9
  71. Library of Communications routines.
  72. :Registration
  73.     Registration is simple. Send $15 to me at the following address:
  74.                  Joseph Teller
  75.                  8 A Middle Street Court
  76.                  Waltham, MA 02154
  77.     Be sure to include your name, return address, the Name of the
  78.     BBS it will be running on and the Phone Number of said BBS.
  79.     The registered copy that you will be sent (on 3.5 disk only)
  80.     will include a KEY FILE, expanded DATA files, and the USER END
  81.     Program that you can set up so your users can leave themselves
  82.     personal Reminders.
  83. :ANSI_PICTURES
  84.     One of the many optional features is ANSI displays. This allows
  85.     a user with ANSI to be shown a 'Display of The Month' and a
  86.     'Display of the Day' by the BBS.
  87.     These can be any regular or Animated ANSI you wish to send, they
  88.     will display to the end and will wait for the user to press their
  89.     spacebar or Enter key upon completion.
  90.     Monthly Pictures should be named by the month and end in ANS and
  91.     should have full 8 character file names:
  92.         January .ANS
  93.         February.ANS
  94.         March   .ANS
  95.         April   .ANS
  96.         May     .ANS
  97.         June    .ANS
  98.         July    .ANS
  99.         August  .ANS
  100.         Septembr.ANS
  101.         October .ANS
  102.         November.ANS
  103.         December.ANS
  104.     Daily Pictures, which will show only on one day of the year (such
  105.     as you might use for a special holiday display) should be named
  106.     numerically such as:
  107.         01-01.ANS    02-15.ANS
  108.         12-25.ANS    10-30.ANS
  109. :Quote
  110.      The Daily Random quote option uses the file QUOTE.DAT this file is
  111.      a simple text file, one quote to a line, 80 characters to a line.
  112.      The first line is the total number of quotes in the file, so if
  113.      you add more then increase this number appropriately.
  114.      Quotes can include any standard punctuation you wish.
  115.      A user door is being designed to allow users to add quotes to the
  116.      file from online as well, and will be made available when completed
  117.      to registered sysops.
  118. :History
  119.      The 'Events in History' option uses the file HISTORY.DAT, a simple
  120.      structured Text File, one entry to a line, 80 characters to a
  121.      line.
  122.      Each Line begins with a simple Date Code entry, such as:
  123.           12-07-1941
  124.      No spaces before the numbers, and one space is suggested AFTER 
  125.      the number before the sentence to be displayed.
  126.      As with ALL the Data Files in the system, there is no maximum
  127.      length limit at present and you can edit and add to the file
  128.      with ANY simple ASCII text editor, like the popular QEDIT.
  129. :Birthdays
  130.      This optional file uses the file BIRTHDAY.DAT, a simple structured
  131.      Text File, one entry per line, 80 characters to a line.
  132.      Again Each line begins with a simple Date Code Entry, such as:
  133.          10-30-1961
  134.      No spaces before the numbers, and one space is suggested after
  135.      the number before the sentence to be displayed.
  136.      This can be used for the Birthdays of the Famous, or for users
  137.      on your bbs or whatever.
  138.      As with all Data Files in the system, there is no maximum length
  139.      limit at present and you can edit it with any ASCII text editor.
  140. :Special_Reminders
  141.      These are reminders that you set up for your users to be 
  142.      displayed based on the Day of the Week or the Month of the year.
  143.      It stores the information in the file REMIND.DAT, a simple
  144.      structured Text File, one entry per line, 80 characters to a
  145.      line.
  146.      Each entry should have a Three Letter code to designate when to
  147.      show the entry. These should be the Days of the Week (Sun, Mon,
  148.      Tues, etc) or the First three Letters of the Month (Jan, Feb, Mar)
  149.      and should be followed by a space before the content.
  150.      If you wish an entry to be more than one line in this section, all
  151.      you have to do is continue it on the next line, using the same
  152.      code.
  153.            
  154.      As with all Data Files in the system, there is no maximum length
  155.      limit at present and you can edit it with any ASCII text editor.
  156. :Dated_Reminders
  157.       These are reminders that you set up for your users to be
  158.       displayed based on the actual date on the reminder. They are
  159.       kept in the text file REMINDME.DAT, a simple structured 
  160.       text file, one entry per line, 80 characters to a line.
  161.      Again Each line begins with a simple Date Code Entry, such as:
  162.          10-01-1993
  163.      No spaces before the Code, one space after, and then the
  164.      actual line of text, including any punctuation you might need.
  165.      If you wish an entry to be more than one line in this section, all
  166.      you have to do is continue it on the next line, using the same
  167.      code.
  168.            
  169.      As with all Data Files in the system, there is no maximum length
  170.      limit at present and you can edit it with any ASCII text editor.
  171.      The REGISTERED version includes a second file generated by the
  172.      users themselves thru a seperate Door option you set up on the
  173.      menu screen to place personal reminders for particular dates.
  174. :Bulletins
  175.      SMDI also offers optional support for Sysop Bulletins to be
  176.      added to the sequence, best used when the program is used as
  177.      part of the logon sequence to your bbs.
  178.      Simply place the Bulletins you wish shown into the file area.
  179.      Bulletin Files should be labeled by the simple format of
  180.               BUL01.TXT
  181.               BUL02.TXT
  182.               BUL03.TXT
  183.               ...etc
  184.      There is no limit on how many bulletins you can support this way.
  185.      The system will ONLY show a Bulletin to a User for a maximum of
  186.      seven days after it was created, but will re-offer it as new
  187.      if it has been changed, modified or updated in any way that
  188.      changes the DATE CODE on the actual file.
  189.      Although the system WILL display an ANSI file as a bulletin this
  190.      is not suggested, as it will NOT modify the display if the user
  191.      doesn't have ANSI - this is the only time the program cannot
  192.      understand the difference between the two (This MAY be changed
  193.      in a future version, dependent on how many registered sysops
  194.      we get for the software).
  195. :Delays_&_Ads
  196.      The Unregistered version of the program has some obnoxious 
  197.      added features that you probably don't like. There are some
  198.      time delays built in when its running and it will glaringly
  199.      complain that its unregistered and that you need to send the
  200.      author $$$. It will also run an ad for the Authors BBS. This
  201.      is all incentive to REGISTER the software as soon as possible.
  202.      Don't worry, The author doesn't get rich from the programs, I
  203.      can assure you. Most likely the money you send me will be 
  204.      spend on Phone Bills or for me to get software I Use by others
  205.      registered (the only way I can afford to do so).
  206. :The_Future
  207.      SMDI's future is dependent on the number of Registered BBS Sysops.
  208.      I will NOT create the added support features or make them at all
  209.      available for people who don't register the software.
  210.      Redesign to support additional BBS Door systems is possible
  211.      if a sufficient number of people who wish to run the program and
  212.      can't contact me regarding such and providing DFRAME also will
  213.      support the system involved.
  214. :Other_Products
  215.       SMDI is NOT the only program I've got on the shareware market! 
  216.       Other Programs available are:
  217.             SMBBSLV2.ARJ - The Silver Mage BBS Lister, that allows
  218.                            you a door for listing other boards across
  219.                            the USA, Search by State, Area Code etc
  220.                            and other nice Features (Shareware $10).
  221.                            DORINFOx.Def Support ONLY.
  222.            
  223.             HERB600.ARJ  - Herbology Helper 6.0, a Hypertext Database
  224.                            of Herbology information for Home Remedies,
  225.                            Folk Medicine and Magickal Religions. This
  226.                            includes full mouse support, Nice Desktop
  227.                            environment, and has optional VGA graphics
  228.                            support for viewing and artwork of plants.
  229.                            ($35 direct Mail Order ONLY on 3.5 MSDOS
  230.                            Disk). NOT for use on a BBS.
  231. :Update
  232.       Version 2.5 is a maintenance update. We've added a longer
  233.       delay before going to bulletins for those sysops who are
  234.       NOT using the Monthly or Daily ANSI display options as the
  235.       screens tended to scroll off too quickly to read at times.
  236.       The Registered Version is getting an Expanded database of
  237.       information for people, to cover the years ahead.
  238.